home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / rjs.lha / RJS / String / paper / ruled.sty < prev    next >
Text File  |  1991-06-14  |  17KB  |  379 lines
  1. % file: ruled.tex            TeXsis                  version 2.14
  2. % :: $Header: /usr2/myers/texsis/RCS/ruled.tex,v 1.5 90/06/21 13:47:44 myers Stab $
  3. %======================================================================*
  4. %  RULED TABLES.                                E. Myers and F.E. Paige
  5. %
  6. %       The following macros will typeset tables with vertical and
  7. % horizontal rules. The syntax is similar to Ray Cowan's TABLES.TEX,
  8. % but the macros have been completely rewritten. Vertical and horizontal 
  9. % rules are drawn by macros using vertical spacing controlled by struts.
  10. % Usage:
  11. %       \ruledtable
  12. %       <item> <tab> ... <item> <cr>
  13. %       ...
  14. %       <item> <tab> ... <item> \endruledtable
  15. % where <item> is an element of the table (every row must have exactly 
  16. % the same number of items, although some may be blank), <tab> is any
  17. % one of
  18. %     &                 for no vertical rule
  19. %     |  [or \vb]       for vertical rule
  20. %     \| [or \Vb]       for thick vertical rule
  21. %     \dbl              for double vertical rule
  22. % and <cr> is any one of
  23. %     \nr               for no horizontal rule
  24. %     \cr               for horizontal rule
  25. %     \CR [or \crthick] for thick horizontal rule
  26. % The last <cr> must be omitted in favour of the \endruledtable
  27. %
  28. %  For horizontal rules across only some columns use
  29. %       ... \nr
  30. %       \crule | \cskip & \Crule ... \crpart
  31. % where \crpart is a special \cr for the partial rule line and
  32. %       \cskip          no rule for column
  33. %       \crule          horizontal rule for column
  34. %       \Crule          thick horizontal rule for column
  35. % The number of columns must be identical to the other rows.
  36. %
  37. % To change the appearance of the table, modify \TableItem.
  38. %  Several modifications are built in:
  39. %       \LeftJustifyTables      left justify each column
  40. %       \RightJustifyTables     right justify each item
  41. %       \NoJustifyTables        center each item (default)
  42. %       \TightTables            use \ horizontal spacing
  43. %       \LooseTables            use \quad horizontal spacing (default)
  44. %
  45. % Use \bigitem to expand the vertical strut for high or deep items. 
  46. %
  47. %       These macros have been reorganized and substantially revised from
  48. % version 2.13. The following functional changes have been made:
  49. %       (1) The @ signs have been removed from the names of the macros
  50. % used to save the Plain \cr, \span, and & so that they can be used to
  51. % modify the preamble. See above.
  52. %       (2) Macros for partial horizontal rules have been added.
  53. %======================================================================*
  54. % Counters and such:     
  55. \catcode`@=11                                   % @ is a letter here
  56. \catcode`\|=12                                  % make sure | is not active
  57. \catcode`\&=4                                   % and that & is alignment tab
  58.  
  59. \newcount\ncols         \ncols=\z@              % number of columns in table
  60. \newcount\nrows         \nrows=\z@              % number of rows in table
  61. \newcount\curcol        \curcol=\z@             % current column counter
  62. \let\currow=\nrows                              % current row counter
  63.      
  64. \newdimen\thinsize      \thinsize=0.6pt         % thin rule width
  65. \newdimen\thicksize     \thicksize=1.5pt        % thick rule width
  66.  
  67. \newif\iftableinfo      \tableinfotrue          % report rows and columns? Yes
  68. \newif\ifcentertables   \centertablestrue       % center tables? Yes
  69. \def\centeredtables{\centertablestrue}%
  70. \def\noncenteredtables{\centertablesfalse}%
  71. \def\nocenteredtables{\centertablesfalse}%      % synonym !
  72.      
  73. \let\plaincr=\cr                        % save real \cr
  74. \let\plainspan=\span                    % save real \span
  75. \let\plaintab=&                         % save real alignment tab &
  76. \def\ampersand{\char`\&}%               % to print `&' in text
  77. \let\lparen=(                           % save left paren     
  78. \let\NX=\noexpand                       % shorthand for \noexpand is \NX
  79.  
  80. % geek hack
  81.  
  82. \def\line2{\hbox to\hsize}
  83.  
  84. %---------------------------------------*
  85. % Main macros:
  86. %       \ruledtable <table stuff> \endruledtable turns on the ruled
  87. % table definitions and makes the table with \halign. It handles all
  88. % the control stuff; the real work is done by \@RuledTable.
  89.      
  90. \def\ruledtable{\relax                          % make ruled table
  91.     \@BeginRuledTable                           % initialize table
  92.     \@RuledTable}%                              % now process table body
  93.  
  94. %  \@BeginRuledTable does all the work of setting things up before
  95. % we read in the body of the table
  96.  
  97. \def\@BeginRuledTable{%                         % initialize table
  98.    \ncols=0\nrows=0                             % reset row and column count
  99.    \begingroup                                  % keep the following local
  100.     \offinterlineskip                           % so vrules touch
  101.     \def~{\phantom{0}}%                         % ~ is phantom digit
  102.     \def\span{\plainspan\omit\relax\colcount\plainspan}%  \span USER columns
  103.     \let\cr=\crrule                             % \cr gives a \tablerule
  104.     \let\CR=\crthick                            % \CR gives a \thickrule
  105.     \let\nr=\crnorule                           % \nr give no rule
  106.     \let\|=\Vb                                  % thick vrule between columns
  107. % 
  108. % support old \tablestrut in place of \tstrut if it exists
  109. %
  110.     \ifx\tablestrut\undefined\relax             % if not defined, no problem
  111.     \else\let\tstrut=\tablestrut\fi             % use \tablestrut
  112. %
  113.     \catcode`\|=13 \catcode`\&=13\relax         % make | and & active
  114.     \TableActive                                % | and & get active \def`s
  115.     \curcol=1                                   % reset column count
  116. %
  117. % define \Halign to do an \halign with or without a width
  118. %
  119.     \ifdim\tablewidth>-\maxdimen\relax          %
  120.       \edef\@Halign{\NX\halign to \NX\tablewidth\NX\bgroup\TablePreamble}% 
  121.       \tabskip=0pt plus 1fil                    % let things stretch
  122.     \else                                       %
  123.       \edef\@Halign{\NX\halign\NX\bgroup\TablePreamble}% 
  124.       \tabskip=0pt                              % no stretch between columns
  125.     \fi                                         %
  126. %
  127. % center text if needed
  128. %
  129.     \ifcentertables                             % should table be centered?
  130.        \ifhmode\vskip 0pt\fi                    % yes: force vertical mode
  131.        \line2\bgroup\hss                         % center across page
  132.     \else\hbox\bgroup                           % else: just put in \hbox
  133.     \fi}%                                       % end of \@BeginRuledTable
  134.  
  135.  
  136. %       \@RuledTable builds the table with \@Halign and getting the
  137. % table body text as its argument.
  138.  
  139. \long\def\@RuledTable#1\endruledtable{%         % ruled table alignment
  140.    \vrule width\thicksize                       % thick rule on side
  141.      \vbox{\@Halign                             % then do \halign
  142.        \thickrule                               % thick rule on top
  143.        #1\relax                                 % body of table
  144.        \tstrut                                  % vertical strut for last line
  145.        \plaincr\thickrule                       % \cr, thick rule on bottom
  146.      \egroup}%                                  % end of \halign and \vbox
  147.    \vrule width\thicksize                       % thick rule on side, end \hbox
  148.    \ifcentertables\hss\fi\egroup                % finish table centering
  149.   \endgroup                                     % end group from \ruledtable
  150.   \global\tablewidth=-\maxdimen                 %   and reset width
  151.   \iftableinfo                                  % report rows and columns
  152.       \immediate\write16{[Nrows=\the\nrows, Ncols=\the\ncols]}%
  153.    \fi}%                                        % end of \@RuledTable
  154.      
  155. %---------------------------------------*
  156. % Preamble and item macros:
  157. %       This is the preamble for the \halign in \ruledtable. 
  158. % To change how each item is processed change \TableItem.
  159. % To make a more complicated table you can change the \TablePreamble,
  160. % but if yo do so use the following substitutions in a standard \halign 
  161. % preamble:
  162. %    for  &     use     \plaintab
  163. %    for  \cr   use     \plaincr
  164. %    for  #     use     ##
  165. %    for  ##    use     ####
  166. % and put \linecount in the first column so that line counting
  167. % works properly.
  168.  
  169. \def\TablePreamble{%                    % \ruledtable preamble
  170.    \linecount                           % count this line
  171.    \TableItem{####}%                    % the first item
  172.    \plaintab\plaintab                   % && means repeat this
  173.    \TableItem{####}%                    % the subsequent items
  174.    \plaincr}%                           % end of preamble
  175.  
  176. %       \TableItem contains glue or spacing around the item
  177.  
  178. \def\@TableItem#1{%                             % centers item in ruled table
  179.    \hfil\tablespace                             % left glue
  180.    #1\relax                                     % item
  181.    \tablespace\hfil                             % right glue
  182.     }%
  183.  
  184. \def\@tableright#1{%                    % right justifies item in ruled table
  185.    \hfil\tablespace\relax               % left glue
  186.    #1\relax                             % item
  187.    \tablespace\relax}%                  % right glue
  188.  
  189. \def\@tableleft#1{%                     % left justifies item in ruled table
  190.    \tablespace\relax                    % left glue
  191.    #1\relax                             % item
  192.    \tablespace\hfil}%                   % right glue
  193.  
  194. \let\TableItem=\@TableItem              % default is centered
  195.      
  196. \def\RightJustifyTables{\let\TableItem=\@tableright}%   % to right justify
  197. \def\LeftJustifyTables{\let\TableItem=\@tableleft}%     % to left justify
  198. \def\NoJustifyTables{\let\TableItem=\@TableItem}%       % to center
  199.  
  200. \def\LooseTables{\let\tablespace=\quad}%        % table spacing is \quad
  201. \def\TightTables{\let\tablespace=\space}%       % table spacing is space
  202. \LooseTables                                    % default is \quad
  203.  
  204. %---------------------------------------*
  205. % Table Height and Width:
  206. %
  207. %  Normally tables are set to their natural width.  If \tablewidth
  208. %  has been set then we set the table to that width instead,
  209. %  but only for the next table.  Then \tablewidth is turned off
  210.  
  211.  
  212. \newdimen\tablewidth    \tablewidth=-\maxdimen  % start ``turned off''
  213.  
  214. %      \setRuledStrut sets up the vertical strut \tstrut with
  215. % the appropriate dimensions to hold up one line of a ruled table. 
  216.  
  217.  
  218. \def\setRuledStrut{% sets interlines spacing for ruled tables
  219.    \dimen@=\baselineskip                        % \dimen@ = extra space
  220.    \advance\dimen@ by-\normalbaselineskip       % between lines
  221.    \ifdim\dimen@<.5ex \dimen@=.5ex\fi           % minimum space
  222.    \setbox0=\hbox{\lparen}%                     % get character size
  223.    \dimen1=\dimen@ \advance\dimen1 by \ht0      % space above line
  224.    \dimen2=\dimen@ \advance\dimen2 by \dp0      % space below line
  225.    \def\tstrut{\vrule height\dimen1 depth\dimen2 width\z@}%
  226.    }%
  227.  
  228. \def\tstrut{\vrule height 3.1ex depth 1.2ex width 0pt}%  default
  229.  
  230.  
  231. %      \tstrut does not produce the correct spacing if the entry in
  232. % the table is too high. The following constructs a strut higher than its
  233. % argument and then prints the argument. The minimum space value should
  234. % be the same as in \setRuledStrut. 
  235.  
  236.  
  237. \def\bigitem#1{%                                % larger table entry
  238.    \setbox0=\hbox{#1}%                          % put arg. in box and
  239.    \dimen1 =\ht0 \dimen2 =\dp0                  % get its size
  240.    \dimen@ =\baselines@ve                       % \dimen@ = extra space
  241.    \advance\dimen@ by-\normalbaselineskip       %   between lines
  242.    \ifdim\dimen@<.25ex \dimen@=.25ex\fi         % minimum space
  243.    \advance\dimen1 by \dimen@                   % space above line
  244.    \advance\dimen2 by \dimen@                   % space below line
  245.    \vrule height\dimen1 depth\dimen2 width\z@   % make strut to size
  246.    \copy0}%                                     % print argument
  247.  
  248.  
  249. %       \vctr{stuff} centers the stuff vertically, so that it can
  250. % appear between two ROWS.
  251.      
  252. \def\vctr#1{\hfil\vbox to 0pt{\vss\hbox{#1}\vss}\hfil}%
  253.  
  254. %---------------------------------------*
  255. % Vertical rules:
  256. %       \tab, \vb and \Vb are used in a table to separate columns with no
  257. % rule, a thin rule, or a thick rule, respectively.  \nextcolumn{<rule>} skips
  258. % to  the next column and puts the <rule> between columns.  Use this to build
  259. % your own separators.
  260.      
  261. \def\nextcolumn#1{%                             % move to next col.
  262.    \plaintab\omit#1\relax\colcount              % tab, insert #1, count
  263.    \plaintab}%                                  % tab to next user col.
  264.      
  265. \def\tab{%                                      % no rule between columns
  266.    \nextcolumn{\relax}}%                        % count column
  267.  
  268. \let\novb=\tab                                  % synonym for \tab
  269.  
  270. \def\vb{%                                       % thin rule between columns
  271.    \nextcolumn{\vrule width\thinsize}}%         % count and rule
  272.  
  273. \def\Vb{%                                       % THICK rule between columns
  274.    \nextcolumn{\vrule width\thicksize}}%        % count and thick rule
  275.  
  276. \def\dbl{%                                      % double rule between columns
  277.    \nextcolumn{\vrule width\thinsize            % count and rule
  278.    \hskip\thinsize\vrule width\thinsize}}%      % and skip and rule
  279.  
  280. %       \TableActive makes | the same as \vb and & the same as \tab so
  281. % these single characters can be used between columns. Here we have to
  282. % make & and | active so we get the active version of the characters,
  283. % hence the temporary change of \catcode.
  284.      
  285. {\catcode`\|=13 \let|0
  286.  \catcode`\&=13 \let&0
  287.  \gdef\TableActive{\let|=\vb \let&=\tab}%
  288. }% end \catcode`s
  289.  
  290. %---------------------------------------*
  291. % Horizontal rules:
  292. %       These replacements for \cr put a wide \vrule at the end of the
  293. % line and maybe put a rule under the line, then begin the next line
  294. % with the wide \vrule from the preamble.
  295.      
  296.  
  297. \def\crrule{\relax                      % \cr plus rule
  298.    \tstrut                              % strut for spacing
  299.    \plaincr\tablerule                   % \cr, regular rule below line
  300.   }%
  301.  
  302. \def\crthick{\relax                     % \cr plus thick rule
  303.    \tstrut                              % strut for vertical spacing
  304.    \plaincr\thickrule                   % \cr, rule, begin next line
  305.   }%                
  306.      
  307. \def\crnorule{\relax                    % \cr plus no rule
  308.    \tstrut                              % strut for spacing
  309.    \plaincr                             % \cr, norule, begin next line
  310.    }%
  311.    
  312. \def\crpart{\plaincr}%                  % for partial rules, no strut
  313.  
  314.  
  315. %       These rules go across the table.
  316.      
  317. \def\tablerule{\noalign{\hrule height\thinsize depth 0pt}}%
  318. \def\thickrule{\noalign{\hrule height\thicksize depth 0pt}}%
  319.  
  320.  
  321. %       Rules for individual columns. You must use \cskip in columns
  322. % with no rules to \omit the \TablePreamble.
  323.  
  324. \def\cskip{\omit\relax}%
  325. \def\crule{\omit\leaders\hrule height\thinsize depth0pt\hfill}%
  326. \def\Crule{\omit\leaders\hrule height\thicksize depth0pt\hfill}%
  327.      
  328. %---------------------------------------*
  329. % Counting macros:     
  330. %       These macros count rows and columns of the table. After the
  331. % first line has been processed \the\ncols is the total number of
  332. % columns in the table, which may be useful. During processing,
  333. % \the\curcol is the number of the current column, while \the\currow is
  334. % the number of the current row.
  335.      
  336.  
  337. \def\linecount{\relax\global\ncols=\curcol      % save column count in \ncols
  338.    \global\curcol=1                             % and reset counter
  339.    \global\advance\nrows by 1\relax}%           % and advance row counter
  340.      
  341. \def\colcount{\relax                            %
  342.    \global\advance\curcol by 1\relax}%          % advance column counter
  343.  
  344. %---------------------------------------*
  345. % TEXT TABLES.
  346. %  To put text in a table use \para{<text>}, with \parasize set
  347. %  to the desired width of the text.
  348.  
  349.  
  350. \newdimen\parasize      \parasize=4in           % paragraph size in tables
  351.  
  352. \long\def\para#1{%
  353.   \vtop{\hsize=\parasize                %       
  354.    \baselineskip=14pt \lineskip=1pt     %
  355.    \lineskiplimit=1pt                   %
  356.    \noindent #1\relax                   %
  357.    \vrule width 0pt depth 6pt}%         % hold depth of box
  358. }%
  359.  
  360. %---------------------------------------*
  361. % TABLES.TEX
  362. %   For compatability with Cowan's TABLES.TEX we also allow the
  363. % syntax \begintable ... \endtable, which do the same thing.
  364. %
  365.  
  366. \def\begintable{\relax                          % make ruled table
  367.     \@BeginRuledTable                           % initialize table
  368.     \@begintable}%                              % now process table body
  369.  
  370. \long\def\@begintable#1\endtable{%              % ruled table alignment
  371.    \@RuledTable#1\endruledtable}%               % same as \ruledtable
  372.  
  373. %---------------------------------------*
  374. % Turn off @ as letter before we exit
  375.  
  376. \catcode`@=12                                   % @ is not a letter
  377.  
  378. %>>> EOF TXSruled.tex <<<
  379.